<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Retrieve the quota level settings, and usage statics per mailbox</title>
 </head>
 <body class="docs"><div id="layout">
  <div id="layout-content"><div id="function.imap-get-quota" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imap_get_quota</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.5, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">imap_get_quota</span> &mdash; <span class="dc-title">Retrieve the quota level settings, and usage statics per mailbox</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-get-quota-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>imap_get_quota</strong></span>
    ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$quota_root</code></span>
   ) : <span class="type">array</span></div>

  <p class="para rdfs-comment">
   Retrieve the quota level settings, and usage statics per mailbox.
  </p>
  <p class="para">
   For a non-admin user version of this function,
   please see the <span class="function"><a href="imap_get_quotaroot.html" class="function">imap_get_quotaroot()</a></span> function of PHP.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.imap-get-quota-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>

    <dt>
<code class="parameter">
imap_stream</code></dt>
<dd>
<p class="para">由 <span class="function"><a href="imap_open.html" class="function">imap_open()</a></span> 返回的 IMAP 流。</p></dd>

    
     <dt>
<code class="parameter">quota_root</code></dt>

     <dd>

      <p class="para">
       <code class="parameter">quota_root</code> should normally be in the form of
       <em>user.name</em> where name is the mailbox you wish to
       retrieve information about.
      </p>
     </dd>

    
   </dl>

  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.imap-get-quota-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   Returns an array with integer values limit and usage for the given
   mailbox.  The value of limit represents the total amount of space
   allowed for this mailbox.  The usage value represents the mailboxes
   current level of capacity.  Will return <strong><code>FALSE</code></strong> in the case of failure.
  </p>
  <p class="para">
   As of PHP 4.3, the function more properly reflects the
   functionality as dictated by the <a href="http://www.faqs.org/rfcs/rfc2087" class="link external">&raquo;&nbsp;RFC2087</a>.
   The array return value has changed to support an unlimited number of returned 
   resources (i.e.  messages, or sub-folders) with each named resource receiving
   an individual array key.  Each key value then contains an another array with
   the usage and limit values within it.
  </p>
  <p class="para">
   For backwards compatibility reasons, the original access methods are
   still available for use, although it is suggested to update.
  </p>
 </div>

 <div class="refsect1 examples" id="refsect1-function.imap-get-quota-examples">
  <h3 class="title">范例</h3>
  <p class="para">
   <div class="example" id="example-4021">
    <p><strong>Example #1 <span class="function"><strong>imap_get_quota()</strong></span> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$mbox&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"{imap.example.org}"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"mailadmin"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"password"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">OP_HALFOPEN</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;die(</span><span style="color: #DD0000">"can't&nbsp;connect:&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">imap_last_error</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">$quota_value&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">imap_get_quota</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"user.kalowsky"</span><span style="color: #007700">);<br />if&nbsp;(</span><span style="color: #0000BB">is_array</span><span style="color: #007700">(</span><span style="color: #0000BB">$quota_value</span><span style="color: #007700">))&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"Usage&nbsp;level&nbsp;is:&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">$quota_value</span><span style="color: #007700">[</span><span style="color: #DD0000">'usage'</span><span style="color: #007700">];<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"Limit&nbsp;level&nbsp;is:&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">$quota_value</span><span style="color: #007700">[</span><span style="color: #DD0000">'limit'</span><span style="color: #007700">];<br />}<br /><br /></span><span style="color: #0000BB">imap_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
    </div>

   </div>
  </p>
  <p class="para">
   <div class="example" id="example-4022">
    <p><strong>Example #2 <span class="function"><strong>imap_get_quota()</strong></span> 4.3 or greater example</strong></p>
    <div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$mbox&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"{imap.example.org}"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"mailadmin"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"password"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">OP_HALFOPEN</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;die(</span><span style="color: #DD0000">"can't&nbsp;connect:&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">imap_last_error</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">$quota_values&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">imap_get_quota</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"user.kalowsky"</span><span style="color: #007700">);<br />if&nbsp;(</span><span style="color: #0000BB">is_array</span><span style="color: #007700">(</span><span style="color: #0000BB">$quota_values</span><span style="color: #007700">))&nbsp;{<br />&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$storage&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$quota_values</span><span style="color: #007700">[</span><span style="color: #DD0000">'STORAGE'</span><span style="color: #007700">];<br />&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"STORAGE&nbsp;usage&nbsp;level&nbsp;is:&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;&nbsp;</span><span style="color: #0000BB">$storage</span><span style="color: #007700">[</span><span style="color: #DD0000">'usage'</span><span style="color: #007700">];<br />&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"STORAGE&nbsp;limit&nbsp;level&nbsp;is:&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;&nbsp;</span><span style="color: #0000BB">$storage</span><span style="color: #007700">[</span><span style="color: #DD0000">'limit'</span><span style="color: #007700">];<br /><br />&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$message&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$quota_values</span><span style="color: #007700">[</span><span style="color: #DD0000">'MESSAGE'</span><span style="color: #007700">];<br />&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"MESSAGE&nbsp;usage&nbsp;level&nbsp;is:&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;&nbsp;</span><span style="color: #0000BB">$message</span><span style="color: #007700">[</span><span style="color: #DD0000">'usage'</span><span style="color: #007700">];<br />&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #DD0000">"MESSAGE&nbsp;limit&nbsp;is:&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;&nbsp;</span><span style="color: #0000BB">$message</span><span style="color: #007700">[</span><span style="color: #DD0000">'limit'</span><span style="color: #007700">];<br /><br />&nbsp;&nbsp;&nbsp;</span><span style="color: #FF8000">/*&nbsp;...&nbsp;&nbsp;*/<br /></span><span style="color: #007700">}<br /><br /></span><span style="color: #0000BB">imap_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
    </div>

   </div>
  </p>
 </div>

 <div class="refsect1 notes" id="refsect1-function.imap-get-quota-notes">
  <h3 class="title">注释</h3>
  <p class="para">
   This function is currently only available to users of the c-client2000
   or greater library.
  </p>
  <p class="para">
   The given <code class="parameter">imap_stream</code> must be opened as the mail
   administrator, otherwise this function will fail.
  </p>
 </div>

 <div class="refsect1 seealso" id="refsect1-function.imap-get-quota-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="function"><a href="imap_open.html" class="function" rel="rdfs-seeAlso">imap_open()</a> - Open an IMAP stream to a mailbox</span></li>
    <li class="member"><span class="function"><a href="imap_set_quota.html" class="function" rel="rdfs-seeAlso">imap_set_quota()</a> - Sets a quota for a given mailbox</span></li>
    <li class="member"><span class="function"><a href="imap_get_quotaroot.html" class="function" rel="rdfs-seeAlso">imap_get_quotaroot()</a> - Retrieve the quota settings per user</span></li>
   </ul>
  </p>
 </div>

</div></div></div></body></html>